---

8. CodeWarrior Documentation

This chapter gives you an insight into the technical diversity of CodeWarrior's documentation. It provides you with information on CodeWarriors documentaion resources to help you blend into the technical mainstream quickly and easily. The following topics are covered in this chapter:

• CodeWarrior Online Help
• Documentation
• Books
• Web Sites of Interest
• Beginner's Resources
• Factory Updates

CodeWarrior includes a wealth of online documentation covering all aspects of programming. Table 8.1 describes the different kinds of CodeWarrior online help and their functions.

• CodeWarrior Platform Specific Online Help
• Cross-Platform Help Solutions

The CodeWarrior online help on Windows, Mac OS, and UNIX provides core CodeWarrior documentation as well as a task oriented approach to learning the IDE. It consists of the following:

• How To Topics - These procedural topics provide simple, easy to follow instructions on performing tasks common to using the CodeWarrior IDE. For example, Creating a New Project, Viewing Variables etc.
• Error Reference - a complete listing of common error messages generated by CodeWarrior and their possible solutions.
• Glossary - Consists of terms and their definitions specific to CodeWarrior.
• CodeWarrior manuals- Includes complete text of some of CodeWarrior's manuals including User Guides, Targeting Manuals, and Reference Manuals .

Format	Description
WinHelp (Windows)	The Help format for Windows. Consists of reference manuals, task topics, core manuals, and a CodeWarrior specific glossary.
QuickHelp (Mac OS)	The QuickHelp format on Mac OS consists of the same content as WinHelp.
HyperHelp (UNIX)	HyperHelp format for UNIX consists of the same Help content as WinHelp.

We provide cross-platform online assistance through two of the most popular and powerful formats - HTML and PDF.

Cross-Platform Help	Type
HTML	HTML files are small, fast, and provide quick and efficient mode of online documentation.
PDF	PDFs are compact and provide excellent printing qualities offering a near-perfect representation of the original.

CodeWarrior offers the following kinds of printed documentation. You can find the online versions of these manuals in the Doc-umentation\CodeWarrior folder on your CodeWarrior CD.

CodeWarrior documentation is classified as follows:

• QuickStart Manuals
• User Guides
• Targeting Manuals
• Reference Manuals

The QuickStart manual includes the basic information required to install and use CodeWarrior, its documentation, a simple tutorial to create a C console application, and information on contacting Metrowerks for technical support, as well as registering, buying, or licensing a product. Please refer to QuickStart Professional for desktop products and QuickStart Embedded for CodeWarrior embedded products.

The User Guides provide information you need to effectively use the CodeWarrior software. All common features available in the CodeWarrior IDE are documented in its user guide. For example, Inside CodeWarrior:IDE User Guide discusses the powerful features of the CodeWarrior IDE, its debugger, and RAD (Rapid Application Development) in great detail. Please refer to Targeting manuals for target specific information.

CodeWarrior offers a wide range of Targeting manuals for several platforms. These manuals describe how to use CodeWarrior to develop code for a specific platform or processor. Targeting manuals also include information about platform-specific features that are not found in a common user guide. Table 8.3 lists a few of the many targeting manuals we offer.

Targeting Manuals	Platform
Targeting Windows	Win32/x86
Targeting Mac OS	Mac OS
Targeting Java VM	Java VM on Windows, Mac, and Solaris

The Reference manuals provide descriptive reference information of a language (C/C++/Java/Pascal) or a programming API (MSL, PowerPlant, etc). Reference manuals normally apply to all CodeWarrior supported platforms. However, there are exceptions. While the C, Java, and Pascal reference manuals are all cross-platform, PowerPlant Reference is not.

To aid your learning curve, CodeWarrior consists of a comprehensive set of books and documentation provided by some of our partners in the industry today. While CodeWarrior documentation is produced and supported by Metrowerks, the third-party documentation is included for your benefit. Please refer to the Partner folder on the Reference CD for a comprehensive set of third-party books.

The CodeWarrior CD also provides additional third party programming books written by popular authors that cover programming on different platforms and languages supported by the CodeWarrior IDE. Please refer to the Books folder for the list of books provided for your convenience.

Table 8.4 lists several third-party books available in your favorite local or online bookstore that can assist you in getting up to speed on your programming projects.

To learn	Read this book
C	New C Primer by Michael Waite and Stephen Prata Teach Yourself C by Herb Schildt The C Programming Language, 2nd Edition by B. Kernighan and D. Ritchie
C++	C++ Primer Plus, 3rd Edition by Stephen Prata Teach Yourself C++ by Herb Schildt The C++ Programming Language, 2nd Edition by Bjarne Stroustrup.
CodeWarrior	Metrowerks CodeWarrior Programming by Dan Parks Sydow Power Macintosh Programming Starter Kit by Tom Thompson
Win32/x86	Advanced Windows® by Jeffrey Richter Programming Windows® 95 by Arnold Petzold
Mac OS	Macintosh Programming Techniques by Dan Parks Sydow Macintosh C Programming Primer, Volume 1 by D. Mark & C. Reed Programming Starter Kit for Macintosh by Jim Trudeau Ultimate Macintosh Programming by Dave Mark

For your convenience, CodeWarrior provides documentation viewers such as Acrobat Reader, QuickHelp, and Internet Explorer with its documentation. Please see the Viewers folder on the CD to install preferred documentation viewers.

Programming tools change fast and access to the latest information about a particular technology or programming environment is vital. Listed below are some of the major Web sites where developer information can be obtained:

For information on this target	See this Web site
Linux	http://www.linux.org
Mac OS	http://devworld.apple.com
MIPS	http://www.sgi.com/MIPS/
NEC	http://www.nec.com/
Palm OS	http://palmpilot.3com.com/5024.html
PowerPC Embedded	http://www.mot.com/SPS/PowerPC/
Solaris	http://docs.sun.com
Windows CE	http://www.microsoft.com/msdn
Windows	http://www.microsoft.com/msdn

Always refer to the CodeWarrior website (www.metrowerks.com) for a detailed description and comprehensive listing of printed and online books, online tutorials, and additional information on programming with CodeWarrior.

For a beginner's tryst with CodeWarrior, see Core Tutorials. They cover the basics of using CodeWarrior. In addition, refer to the IDE User Guide for more in-depth information on creating, editing, compiling, and debugging your software projects.

For language basics, see the reference manuals for all supported languages (C, C++, and Java). Language manuals are located on your CodeWarrior CD at:

Also, refer to the various third party commercial books located at .

For assistance in creating programs for a particular operating system, see the appropriate Targeting manual for the project. Targeting manuals provide all the information you need to successfully program a specific processor or operating system, including additional tutorials and examples.

Metrowerks makes software updates available through its Web site to enhance features or correct bugs in an existing CodeWarrior product. You may download these updates and apply them to the CodeWarrior software installed on your computer.

For information on the latest patches to CodeWarrior software, see http://www.metrowerks.com.